Class Session

Session class represents a HTTP session. It provides methods to perform various HTTP requests.

Constructors

constructor

Properties

alpnProtocols? alpsProtocols certCompressionAlgo? clientIdentifier? connectionFlow? debug? disableIPV4 disableIPV6 fetch forceHttp1? h2Settings? h2SettingsOrder? headerOrder? headerPriority? headers insecureSkipVerify? ja3string? jar keyShareCurves? priorityFrames? proxy? pseudoHeaderOrder? randomTlsExtensionOrder? sessionId? supportedSignatureAlgorithms? supportedVersions? timeout

Accessors

cookies

Methods

close delete execute free get head options patch post put

Constructors

constructor

Properties

Private Optional alpnProtocols

alpnProtocols?: string[]

Private alpsProtocols

alpsProtocols: string[]

Private Optional certCompressionAlgo

certCompressionAlgo?: CertCompressionAlgo

Private Optional clientIdentifier

clientIdentifier?: ClientIdentifier

Private Optional connectionFlow

connectionFlow?: number

Private Optional debug

debug?: boolean

Private disableIPV4

disableIPV4: boolean

Private disableIPV6

disableIPV6: boolean

Private fetch

fetch: Promise<koffiLoad>

Private Optional forceHttp1

forceHttp1?: boolean

Private Optional h2Settings

h2Settings?: H2Settings

Private Optional h2SettingsOrder

h2SettingsOrder?: (keyof H2Settings)[]

Private Optional headerOrder

headerOrder?: string[]

Private Optional headerPriority

headerPriority?: PriorityParam

Private headers

headers: OutgoingHttpHeaders

Private Optional insecureSkipVerify

insecureSkipVerify?: boolean

Private Optional ja3string

ja3string?: string

Private jar

jar: Cookies = ...

Private Optional keyShareCurves

keyShareCurves?: KeyShareCurves[]

Private Optional priorityFrames

priorityFrames?: PriorityFrames[]

Private Optional proxy

proxy?: null | string

Private Optional pseudoHeaderOrder

pseudoHeaderOrder?: PseudoHeaderOrder[]

Private Optional randomTlsExtensionOrder

randomTlsExtensionOrder?: boolean

Private Optional sessionId

sessionId?: string

Private Optional supportedSignatureAlgorithms

supportedSignatureAlgorithms?: SupportedSignatureAlgorithms[]

Private Optional supportedVersions

supportedVersions?: SupportedVersions[]

Private timeout

timeout: null | number

Accessors

cookies

  • get cookies(): Serialized

  • Retrieves all cookies from the jar.

    This getter fetches all cookies stored in the jar instance of the class.

    Returns Serialized

    An object where keys are URLs and values are objects containing cookies as key-value pairs.

    Example

    { 
           "https://example.com/": {
             "cookie1": "value1",
             "cookie2": "value2"
           },
           "https://anotherdomain.com/": {
             "cookieA": "valueA",
             "cookieB": "valueB"
           }
        }

Methods

close

  • close(): Promise<any>

  • The 'close' method closes the current session.

    Returns Promise<any>

    The response from the 'destroySession' function.

delete

  • delete(url, options?): Promise<Response>

  • The 'delete' method performs a DELETE request to the provided URL with the provided options.

    Parameters

    • url: string

      The URL to perform the DELETE request to.

    • Optional options: DeleteRequestOptions

      The options for the DELETE request.

    Returns Promise<Response>

    The response from the 'execute' method.

Private execute

  • execute(method, url, options): Promise<Response>

  • The 'execute' method performs a HTTP request of the provided method to the provided URL with the provided options.

    Parameters

    • method: Methods

      The HTTP method of the request.

    • url: string

      The URL to perform the request to.

    • options: RequestOptions

      The options for the request.

    Returns Promise<Response>

    A new Response object.

Private free

  • free(id): Promise<void>

  • The 'freeMemory' method frees the memory used by the session with the provided id.

    Parameters

    • id: string

      The id of the session to free the memory of.

    Returns Promise<void>

    The response from the 'destroySession' function.

get

  • get(url, options?): Promise<Response>

  • The 'get' method performs a GET request to the provided URL with the provided options.

    Parameters

    • url: string

      The URL to perform the GET request to.

    • Optional options: GetRequestOptions

      The options for the GET request.

    Returns Promise<Response>

    The response from the 'execute' method.

head

  • head(url, options?): Promise<Response>

  • The 'head' method performs a HEAD request to the provided URL with the provided options.

    Parameters

    • url: string

      The URL to perform the HEAD request to.

    • Optional options: HeadRequestOptions

      The options for the HEAD request.

    Returns Promise<Response>

    The response from the 'execute' method.

options

  • options(url, options?): Promise<Response>

  • The 'options' method performs an OPTIONS request to the provided URL with the provided options.

    Parameters

    • url: string

      The URL to perform the OPTIONS request to.

    • Optional options: OptionsRequestOptions

      The options for the OPTIONS request.

    Returns Promise<Response>

    The response from the 'execute' method.

patch

  • patch(url, options?): Promise<Response>

  • The 'patch' method performs a PATCH request to the provided URL with the provided options.

    Parameters

    • url: string

      The URL to perform the PATCH request to.

    • Optional options: PatchRequestOptions

      The options for the PATCH request.

    Returns Promise<Response>

    The response from the 'execute' method.

post

  • post(url, options?): Promise<Response>

  • The 'post' method performs a POST request to the provided URL with the provided options.

    Parameters

    • url: string

      The URL to perform the POST request to.

    • Optional options: PostRequestOptions

      The options for the POST request.

    Returns Promise<Response>

    The response from the 'execute' method.

put

  • put(url, options?): Promise<Response>

  • The 'put' method performs a PUT request to the provided URL with the provided options.

    Parameters

    • url: string

      The URL to perform the PUT request to.

    • Optional options: PutRequestOptions

      The options for the PUT request.

    Returns Promise<Response>

    The response from the 'execute' method.

Settings

Member Visibility

Theme

On This Page

constructoralpnProtocolsalpsProtocolscertCompressionAlgoclientIdentifierconnectionFlowdebugdisableIPV4disableIPV6fetchforceHttp1h2Settingsh2SettingsOrderheaderOrderheaderPriorityheadersinsecureSkipVerifyja3stringjarkeyShareCurvespriorityFramesproxypseudoHeaderOrderrandomTlsExtensionOrdersessionIdsupportedSignatureAlgorithmssupportedVersionstimeoutcookiesclosedeleteexecutefreegetheadoptionspatchpostput