@zcatalyst/transport 0.0.2 → 0.0.3

package/dist-types/ts3.4/utils/form-data.d.ts

@@ -10,35 +10,276 @@ export default class FormData extends Stream {
     insideLoop: boolean;
     pendingNext: boolean;
     boundary: string | undefined;
+    /**
+     * Creates a FormData instance.
+     * @param streams - The streams value.
+     */
     constructor(streams?: Array<formDataType>);
     static LINE_BREAK: string;
     static CONTENT_TYPE: string;
+    /**
+     * Performs is stream for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The is stream result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     isStream(value: unknown): boolean;
+    /**
+     * Performs multi part header for the transport package.
+     *
+     * @param field - The field value.
+     * @param value - The value to validate.
+     * @returns The multi part header result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _multiPartHeader(field: string, value: formDataType): string;
-    _getContentDisposition(value: any): string | undefined;
+    /**
+     * Performs get content disposition for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The get content disposition result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _getContentDisposition(value: unknown): string | undefined;
+    /**
+     * Performs get content type for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The get content type result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _getContentType(value: formDataType): string;
+    /**
+     * Performs last boundary for the transport package.
+     *
+     * @returns The last boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _lastBoundary(): string;
+    /**
+     * Performs generate boundary for the transport package.
+     *
+     * @returns The generate boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _generateBoundary(): string;
+    /**
+     * Performs error for the transport package.
+     *
+     * @param err - The err value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _error(err: Error): void;
+    /**
+     * Performs handle stream errors for the transport package.
+     *
+     * @param stream - The stream value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _handleStreamErrors(stream: Stream): void;
+    /**
+     * Performs pipe next for the transport package.
+     *
+     * @param stream - The stream value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _pipeNext(stream: formDataType): void;
+    /**
+     * Performs get next for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _getNext(): void;
+    /**
+     * Performs reset for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _reset(): void;
+    /**
+     * Performs create clone for the transport package.
+     *
+     * @returns The create clone result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     createClone(): FormData;
+    /**
+     * Performs append for the transport package.
+     *
+     * @param field - The field value.
+     * @param value - The value to validate.
+     * @returns The append result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     append(field: string, value: unknown): this;
+    /**
+     * Performs get headers for the transport package.
+     *
+     * @param userHeaders - The user headers value.
+     * @returns The get headers result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     getHeaders(userHeaders: {
         [x: string]: string;
     }): {
         [x: string]: string;
     };
+    /**
+     * Performs get boundary for the transport package.
+     *
+     * @returns The get boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     getBoundary(): string;
+    /**
+     * Performs pipe for the transport package.
+     *
+     * @param dest - The dest value.
+     * @param options - The initialization or request options.
+     * @returns The pipe result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     pipe<T extends NodeJS.WritableStream>(dest: T, options?: {
         end?: boolean;
     }): T;
+    /**
+     * Performs write for the transport package.
+     *
+     * @param data - The data value.
+     * @returns The write result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     write(data: Uint8Array | string): boolean;
+    /**
+     * Performs pause for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     pause(): void;
+    /**
+     * Performs resume for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     resume(): void;
+    /**
+     * Performs end for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     end(): void;
+    /**
+     * Performs destroy for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     destroy(): void;
+    /** function toString() { [native code] } */
     toString(): string;
 }

package/dist-types/ts3.4/utils/helpers.d.ts

@@ -1 +1,13 @@
+/**
+ * Reports whether a URL uses the HTTPS protocol.
+ *
+ * @param url - The URL to update or request.
+ * @returns True when the URL uses HTTPS.
+ *
+ * @example
+ * ```ts
+ * import { Handler } from '@zcatalyst/transport';
+ * const result = isHttps("https://example.com");
+ * ```
+ */
 export declare function isHttps(url?: string | URL): boolean;

package/dist-types/ts3.4/utils/interfaces.d.ts

@@ -2,6 +2,7 @@ import { CatalystService } from '@zcatalyst/utils';
 import { RequestType, ResponseType } from './enums';
 export interface Component {
     getComponentName(): string;
+    getComponentVersion?(): string;
 }
 export interface jwtAccessTokenResponse {
     access_token: string;
@@ -27,6 +28,8 @@ export interface RequestHandlerOptions {
     requestTimeout?: number;
     expecting?: ResponseType;
     auth?: boolean;
+    duplex?: string;
+    service?: CatalystService;
 }
 export interface HTTP_CODE_MAP_BODY_TYPE {
     CODE: number;
@@ -43,9 +46,10 @@ export interface FORMDATA {
     name: string;
 }
 export interface IRequestConfig {
+    duplex?: string;
     data?: string | Array<{
         [x: string]: unknown;
-    }> | Array<string | number> | Record<string, unknown> | ReadableStream | NodeJS.ReadableStream;
+    }> | Array<string | number> | Record<string, unknown> | unknown;
     type?: RequestType;
     qs?: Record<string, string | number | boolean | undefined>;
     path?: string;

package/dist-types/ts3.4/utils/request-agent.d.ts

@@ -2,5 +2,11 @@ import { Agent as httpAgent } from 'http';
 import { Agent as httpsAgent } from 'https';
 export default class RequestAgent {
     agent: httpAgent | httpsAgent;
+    /**
+     * Creates a RequestAgent instance.
+     * @param isHttps - The isHttps value.
+     * @param host - The host value.
+     * @param replaceAgent - The replaceAgent value.
+     */
     constructor(isHttps: boolean, host: string, replaceAgent: boolean);
 }

package/dist-types/ts3.4/utils/request-timeout.d.ts

@@ -1 +1,13 @@
+/**
+ * Creates a promise that rejects when a request exceeds the configured timeout.
+ *
+ * @param timeoutInMs - The timeout duration in milliseconds.
+ * @returns A promise that rejects when the timeout elapses.
+ *
+ * @example
+ * ```ts
+ * import { Handler } from '@zcatalyst/transport';
+ * const result = undefined;
+ * ```
+ */
 export declare function requestTimeout(timeoutInMs?: number): Promise<never>;

package/dist-types/utils/clonable-stream.d.ts

@@ -1,10 +1,37 @@
 import { PassThrough, Readable } from 'stream';
 declare class StreamClone extends PassThrough {
     parent: CloneableStream;
+    /**
+     * Creates a StreamClone instance.
+     * @param parent - The parent value.
+     */
     constructor(parent: CloneableStream);
     private onDataClone;
     private onResumeClone;
+    /**
+     * Performs clone for the transport package.
+     *
+     * @returns The clone result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     clone(): StreamClone;
+    /**
+     * Performs is cloneable for the transport package.
+     *
+     * @param stream - The stream value.
+     * @returns The is cloneable result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     isCloneable(stream: unknown): stream is CloneableStream | StreamClone;
 }
 export default class CloneableStream extends PassThrough {
@@ -12,10 +39,37 @@ export default class CloneableStream extends PassThrough {
     _clonesCount: number;
     _internalPipe: boolean;
     _hasListener: boolean;
+    /**
+     * Creates a CloneableStream instance.
+     * @param stream - The stream value.
+     */
     constructor(stream: Readable);
     private onData;
     private onResume;
+    /**
+     * Performs resume for the transport package.
+     *
+     * @returns The resume result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     resume(): this;
+    /**
+     * Performs clone for the transport package.
+     *
+     * @returns The clone result.
+     * @throws {Error} when validation fails.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     clone(): StreamClone;
 }
 export {};

package/dist-types/utils/errors.d.ts

@@ -1,4 +1,11 @@
 import { PrefixedCatalystError } from '@zcatalyst/utils';
 export declare class CatalystAPIError extends PrefixedCatalystError {
+    /**
+     * Creates a CatalystAPIError instance.
+     * @param code - The code value.
+     * @param message - The message value.
+     * @param value - The value value.
+     * @param statusCode - The statusCode value.
+     */
     constructor(code: string, message: string, value?: unknown, statusCode?: number);
 }

package/dist-types/utils/form-data.d.ts

@@ -10,35 +10,276 @@ export default class FormData extends Stream {
     insideLoop: boolean;
     pendingNext: boolean;
     boundary: string | undefined;
+    /**
+     * Creates a FormData instance.
+     * @param streams - The streams value.
+     */
     constructor(streams?: Array<formDataType>);
     static LINE_BREAK: string;
     static CONTENT_TYPE: string;
+    /**
+     * Performs is stream for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The is stream result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     isStream(value: unknown): boolean;
+    /**
+     * Performs multi part header for the transport package.
+     *
+     * @param field - The field value.
+     * @param value - The value to validate.
+     * @returns The multi part header result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _multiPartHeader(field: string, value: formDataType): string;
-    _getContentDisposition(value: any): string | undefined;
+    /**
+     * Performs get content disposition for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The get content disposition result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
+    _getContentDisposition(value: unknown): string | undefined;
+    /**
+     * Performs get content type for the transport package.
+     *
+     * @param value - The value to validate.
+     * @returns The get content type result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _getContentType(value: formDataType): string;
+    /**
+     * Performs last boundary for the transport package.
+     *
+     * @returns The last boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _lastBoundary(): string;
+    /**
+     * Performs generate boundary for the transport package.
+     *
+     * @returns The generate boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _generateBoundary(): string;
+    /**
+     * Performs error for the transport package.
+     *
+     * @param err - The err value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _error(err: Error): void;
+    /**
+     * Performs handle stream errors for the transport package.
+     *
+     * @param stream - The stream value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _handleStreamErrors(stream: Stream): void;
+    /**
+     * Performs pipe next for the transport package.
+     *
+     * @param stream - The stream value.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _pipeNext(stream: formDataType): void;
+    /**
+     * Performs get next for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _getNext(): void;
+    /**
+     * Performs reset for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     _reset(): void;
+    /**
+     * Performs create clone for the transport package.
+     *
+     * @returns The create clone result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     createClone(): FormData;
+    /**
+     * Performs append for the transport package.
+     *
+     * @param field - The field value.
+     * @param value - The value to validate.
+     * @returns The append result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     append(field: string, value: unknown): this;
+    /**
+     * Performs get headers for the transport package.
+     *
+     * @param userHeaders - The user headers value.
+     * @returns The get headers result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     getHeaders(userHeaders: {
         [x: string]: string;
     }): {
         [x: string]: string;
     };
+    /**
+     * Performs get boundary for the transport package.
+     *
+     * @returns The get boundary result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     getBoundary(): string;
+    /**
+     * Performs pipe for the transport package.
+     *
+     * @param dest - The dest value.
+     * @param options - The initialization or request options.
+     * @returns The pipe result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     pipe<T extends NodeJS.WritableStream>(dest: T, options?: {
         end?: boolean;
     }): T;
+    /**
+     * Performs write for the transport package.
+     *
+     * @param data - The data value.
+     * @returns The write result.
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     write(data: Uint8Array | string): boolean;
+    /**
+     * Performs pause for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     pause(): void;
+    /**
+     * Performs resume for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     resume(): void;
+    /**
+     * Performs end for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     end(): void;
+    /**
+     * Performs destroy for the transport package.
+     *
+     *
+     * @example
+     * ```ts
+     * import { Handler } from '@zcatalyst/transport';
+     * const result = undefined;
+     * ```
+     */
     destroy(): void;
+    /** function toString() { [native code] } */
     toString(): string;
 }