Marked additional properties internal

Author: toptobes

src/api/data-api-http-client.ts

@@ -34,6 +34,9 @@ type ExecuteCommandOptions = TimeoutOptions & {
   namespace?: string;
 }
 
+/**
+ * @internal
+ */
 export class DataApiHttpClient extends HttpClient {
   public collection?: string;
   public namespace?: string;
@@ -115,6 +118,9 @@ const mkFauxErroredResponse = (message: string): RawDataApiResponse => {
   return { errors: [{ message }] };
 }
 
+/**
+ * @internal
+ */
 export function replacer(this: any, key: string, value: any): any {
   if (typeof value === 'bigint') {
     return Number(value);
@@ -141,6 +147,9 @@ export function replacer(this: any, key: string, value: any): any {
   return value;
 }
 
+/**
+ * @internal
+ */
 export function reviver(_: string, value: any): any {
   if (!value) {
     return value;
@@ -157,6 +166,9 @@ export function reviver(_: string, value: any): any {
   return value;
 }
 
+/**
+ * @internal
+ */
 export function handleIfErrorResponse(response: any, command: Record<string, any>) {
   if (response.errors && response.errors.length > 0) {
     throw mkRespErrorFromResponse(DataAPIResponseError, command, response);

src/api/devops-api-http-client.ts

@@ -39,6 +39,9 @@ interface LongRunningRequestInfo {
   options: AdminBlockingOptions | undefined,
 }
 
+/**
+ * @internal
+ */
 export class DevopsApiHttpClient extends HttpClient {
   constructor(props: HTTPClientOptions) {
     super(props);

src/api/http-client.ts

@@ -19,6 +19,9 @@ import { HTTP2Strategy } from '@/src/api/http2';
 import { Mutable } from '@/src/data-api/types/utils';
 import { Caller } from '@/src/client';
 
+/**
+ * @internal
+ */
 export class HttpClient {
   public readonly baseUrl: string;
   public readonly userAgent: string;

src/api/http1.ts

@@ -47,6 +47,9 @@ axiosAgent.interceptors.response.use((response) => {
   return response;
 });
 
+/**
+ * @internal
+ */
 export const HTTP1AuthHeaderFactories = {
   DataApi(token: string) {
     return { [DEFAULT_DATA_API_AUTH_HEADER]: token };
@@ -56,6 +59,9 @@ export const HTTP1AuthHeaderFactories = {
   },
 }
 
+/**
+ * @internal
+ */
 export class HTTP1Strategy implements HTTPRequestStrategy {
   constructor(
     private readonly _authHeaderFactory: (token: string) => Record<string, string>,

src/api/http2.ts

@@ -15,6 +15,9 @@
 import * as http2 from 'http2';
 import { HTTPRequestStrategy, GuaranteedAPIResponse, InternalHTTPRequestInfo } from '@/src/api/types';
 
+/**
+ * @internal
+ */
 export class HTTP2Strategy implements HTTPRequestStrategy {
   #session: http2.ClientHttp2Session;
 

src/api/timeout-managers.ts

@@ -44,9 +44,9 @@ export type TimeoutOptions = {
 export type MkTimeoutError = (ctx: InternalHTTPRequestInfo) => Error;
 
 /**
- * A more complex timeout manager that tracks the remaining time for multiple calls, starting from the first call.
- * This is useful for scenarios where multiple calls are made in sequence, and the timeout should be shared among them,
- * e.g. {@link Collection.insertMany}.
+ * Tracks the remaining time before a timeout occurs. Can be used for both single and multi-call timeout management.
+ *
+ * The first call to `msRemaining` will start the timer.
  *
  * @internal
  */