KysoqlAPI referenceInterfaces
RestClientOptions
Generated API reference for RestClientOptions in @kysoql/rest.
@kysoql/rest / RestClientOptions
Connection, authentication, and transport options for the Salesforce REST client.
Extends
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
instanceUrl | readonly | string | Salesforce instance origin used for REST requests. | - |
accessToken | readonly | | string | AccessTokenProvider | Provider is called lazily, then again only after INVALID_SESSION_ID. | - |
apiVersion? | readonly | string | Salesforce REST API version, for example 65.0; defaults to DEFAULT_API_VERSION. | - |
fetch? | readonly | (input, init?) => Promise<Response> | Native fetch by default. An injected implementation must honour signal and redirect. | HttpOptions.fetch |
signal? | readonly | AbortSignal | Combines with the client's signal; cancelling one operation does not cancel others. | HttpOptions.signal |
timeoutMs? | readonly | number | Per HTTP request, including token acquisition and response body. Default: 30 seconds. | HttpOptions.timeoutMs |