Functions — github.com/DemonMartin/tlsClient

hub / github.com/DemonMartin/tlsClient / functions

Functions44 in github.com/DemonMartin/tlsClient

⨍ Functions 44 ◇ Types & classes 21

↓ 7 callersMethodconvertUrl

(url: URL | string)

src/index.ts:632

↓ 7 callersMethodrequest

(options: Partial<TlsClientOptions>)

src/index.ts:693

↓ 5 callersMethodexec

(func: string, args: unknown[])

src/index.ts:874

↓ 5 callersMethodinit

()

src/index.ts:568

↓ 3 callersMethodconvertBody

(body: RequestBody)

src/index.ts:625

↓ 3 callersMethoddestroySession

* @description Destroys the sessionId * @param {string} [id=this.sessionId] - The ID associated with the memory to free. * @returns {Promise

src/index.ts:649

↓ 2 callersMethodget

* @description Send a GET request * @param {URL|string} url - The URL to send the request to * @param {Partial<TlsClientOptions>} [options={

src/index.ts:708

↓ 2 callersMethodterminate

* @description Terminates the worker pool and unloads the TLS library. * @returns {Promise<boolean>} True if the termination was successful, fals

src/utils/client.ts:155

↓ 1 callersMethodcombineOptions

(options: Partial<TlsClientOptions>)

src/index.ts:600

↓ 1 callersFunctioncreateInstance

()

src/utils/worker.ts:13

↓ 1 callersMethoddownloadLibrary

* @description Downloads the TLS library if it does not exist. * @returns {Promise<void>} Promise that resolves when the library is downloaded

src/utils/client.ts:81

↓ 1 callersMethodgetTLSDependencyPath

(customPath?: string | null)

src/utils/path.ts:62

↓ 1 callersFunctiongetWorkerPath

()

src/utils/client.ts:8

↓ 1 callersMethodlibraryExists

* @description Checks if the TLS library exists. * @returns {boolean} True if the library exists, false otherwise.

src/utils/client.ts:73

↓ 1 callersFunctionmain

()

tests/test.simple_request.cjs:3

↓ 1 callersFunctionmain

()

tests/test.simple_request.ts:79

↓ 1 callersMethodopen

* @description Opens the TLS library and initializes the worker pool. * @returns {Promise<void>} Promise that resolves when the library is opened

src/utils/client.ts:110

↓ 1 callersMethodretryRequest

(options: TlsClientOptions)

src/index.ts:677

↓ 1 callersFunctionrunAtConcurrency

( session: SessionClient, concurrency: number, totalRequests: number, )

tests/test.simple_request.ts:37

↓ 1 callersMethodsendRequest

(options: TlsClientOptions)

src/index.ts:665

↓ 1 callersMethodsetDetails

()

src/utils/path.ts:29

↓ 1 callersFunctionstartServer

()

tests/test.simple_request.ts:9

↓ 1 callersMethodstartWorkerPool

* @description Starts the worker pool. * @returns {Piscina} The Piscina worker pool.

src/utils/client.ts:124

↓ 1 callersFunctionstopServer

Stops accepting connections, tears down open sockets, then resolves when the server is fully closed.

tests/test.simple_request.ts:24

Method[Symbol.asyncDispose]

* Explicit async cleanup for `await using session = new SessionClient(...)` (TypeScript 5.2+).

src/index.ts:578

MethodaddCookiesToSession

* @deprecated Use requestCookies instead * @description Add cookies to a given session * @param {string} sessionId - The existing session ID

src/index.ts:857

Methodconstructor

* @description Create a new SessionClient * @param {ModuleClient} moduleClient - The shared ModuleClient instance * @param {TlsClientDefault

src/index.ts:472

Methodconstructor

* @description Creates a new ModuleClient instance. * @param {ModuleClientOptions} [options] - Configuration options for the ModuleClient *

src/utils/client.ts:57

* @description Send a DELETE request * @param {URL|string} url - The URL to send the request to * @param {Partial<TlsClientOptions>} [option

src/index.ts:769

MethoddestroyAll

* @description Destroy all existing sessions in order to release allocated memory. * @returns {Promise<unknown>} Promise that resolves when all s

src/index.ts:870

MethodgetCookiesFromSession

* @description Get the cookies for a given session and URL * @param {string} sessionId - The existing session ID. * @param {string} url - Th

src/index.ts:842

MethodgetPoolStats

* @description Get current pool statistics. * @returns {PoolStats | null} Pool statistics.

src/utils/client.ts:140

MethodgetSession

* @description Gets the session ID if session rotation is not enabled. * @returns {string} The session ID, or null if session rotation is enabled

src/index.ts:640

Functionhandler

(task: WorkerTask)

src/utils/worker.ts:31

Methodhead

* @description Send a HEAD request * @param {URL|string} url - The URL to send the request to * @param {Partial<TlsClientOptions>} [options=

src/index.ts:786

Methodoptions

* @description Send an OPTIONS request * @param {URL|string} url - The URL to send the request to * @param {Partial<TlsClientOptions>} [opti

* @description Send a PATCH request * @param {URL|string} url - The URL to send the request to * @param {object|string} body - The request b

src/index.ts:804

Methodpost

* @description Send a POST request * @param {URL|string} url - The URL to send the request to * @param {object|string} body - The request bo

src/index.ts:726

Methodput

* @description Send a PUT request * @param {URL|string} url - The URL to send the request to * @param {object|string} body - The request bod

src/index.ts:748

Functionrunner

()

tests/test.simple_request.ts:48

MethodsetDefaultCookies

* @description Set the default cookies for the SessionClient * @param {Cookie[]} cookies - Array of cookies to set as defaults * @returns {v

src/index.ts:587

MethodsetDefaultHeaders

* @description Set the default headers for the SessionClient * @param {Record<string, string>} headers - Object containing header key-value pairs

src/index.ts:596