[ML] Add comments to lib functions.

elastic · May 16, 2022 · 08c920d · 08c920d
1 parent c8e95df
commit 08c920d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/x-pack/plugins/aiops/server/lib/accept_compression.ts b/x-pack/plugins/aiops/server/lib/accept_compression.ts
@@ -7,6 +7,12 @@
 
 import type { Headers } from '@kbn/core/server';
 
+/**
+ * Returns whether request headers accept a response using gzip compression.
+ *
+ * @param headers - Request headers.
+ * @returns boolean
+ */
 export function acceptCompression(headers: Headers) {
   let compressed = false;
 

diff --git a/x-pack/plugins/aiops/server/lib/stream_factory.ts b/x-pack/plugins/aiops/server/lib/stream_factory.ts
@@ -22,6 +22,14 @@ class ResponseStream extends Stream.PassThrough {
 
 const DELIMITER = '\n';
 
+/**
+ * Sets up a response stream with support for gzip compression depending on provided
+ * request headers.
+ *
+ * @param logger - Kibana provided logger.
+ * @param headers - Request headers.
+ * @returns An object with stream attributes and methods.
+ */
 export function streamFactory<T extends ApiEndpoint>(logger: Logger, headers: Headers) {
   const isCompressed = acceptCompression(headers);