Class ShareNativeBinding

Share class that acts as an wrapper around the native libcurl share handle.

C++ source code

Using this class you should be able to share data between two {@link "Easy".Easy | Easy} handles, like cookies for instance.

For usage see examples/05-share.js

Hierarchy

ShareNativeBinding
- Share

Index

Methods

Methods

close

close(): void

- Defined in lib/types/ShareNativeBinding.ts:39
Closes this handle.

After the handle has been closed it must not be used again.

This is basically the same than curl_share_cleanup()

Returns void

setOpt

setOpt(option: CurlShareOption, value: CurlShareLock): CurlShareCode

- Defined in lib/types/ShareNativeBinding.ts:30
You can use CurlShareOption and CurlShareLock for predefined constants.

Official libcurl documentation: curl_share_setopt()

Parameters
- option: CurlShareOption
- value: CurlShareLock
Returns CurlShareCode

strError

strError(errorCode: CurlShareCode): string

- Defined in lib/types/ShareNativeBinding.ts:49
Returns a description for the given error code.

Official libcurl documentation: curl_share_strerror()

Parameters
- errorCode: CurlShareCode
Returns string

Generated using TypeDoc