sharetribe-flex-sdk/docs/keep-alive.md

Sharetribe SDK for JavaScript

# Keep-Alive

*Node.js only*

By default, Node.js `http.Agent` and `https.Agent` create a new
connection for each request. After the request is completed, the
connection is closed. By keeping the connection open and reusing it
for subsequent requests, the request time can be reduced. This is
escpecially true for HTTPS connections, where the SSL handshake adds
extra overhead for each request.

The SDK can be configured to use custom `httpAgent` and `httpsAgent`,
where the `keepAlive` can be set to `true`.

Using persistent Keep-Alive connections is **recommended**.

**Example:**

``` js
const express = require('express');
const http = require('http');
const https = require('https');
const sharetribeSdk = require('sharetribe-flex-sdk');

const app = express();

// Instantiate HTTP(S) Agents with keepAlive set to true.
// This will reduce the request time for consecutive requests by
// reusing the existing TCP connection, thus eliminating the time used
// for setting up new TCP connections.
const httpAgent = new http.Agent({ keepAlive: true });
const httpsAgent = new https.Agent({ keepAlive: true });

app.get('/', (req, res) => {
  // Initialize the SDK instance
  const sdk = sharetribeSdk.createInstance({
    clientId: "<your Client ID>",
    baseUrl: "<your Base URL>",
    httpAgent: httpAgent,
    httpsAgent: httpsAgent
  });

  // Call the SDK to preload listings
  sdk.listings.search({ ... }).then((listingsResult) => {
    // do rendering etc.
  });
});
```