HTTPS Agent Configuration

[rdrigos]

Good morning, I searched the documentation and couldn't find anything that could help me. How could I configure an HTTPS agent in the request? I know that in Axios, I can do it this way (the method I'm currently using):

const pemCertificatePath: string = path.join(process.cwd(), util.format('certificates/%s', env.COUPA_CERT_PEM));
const keyCertificatePath: string = path.join(process.cwd(), util.format('certificates/%s', env.COUPA_CERT_KEY));


this.api = Axios.create({
  baseURL: env.COUPA_API_URL,
  httpsAgent: new https.Agent({
    cert: fs.readFileSync(pemCertificatePath),
    key: fs.readFileSync(keyCertificatePath),
    rejectUnauthorized: false,
  }),
});

Since I intend to change from Axios to Ky, how could I configure the certificates?

[sindresorhus]

See: #526 (comment)

[jsmartt]

I'm not seeing any relevant info in #526 that answers this question. I am also curious about this because I need to configure https agent options (ca cert) programatically. Is there a way to do that with ky?

[jsmartt]

After some digging and trial and error, I found that this works:

import { Agent } from 'undici';
import fs from 'fs';
import ky from 'ky';

const customCa = fs.readFileSync('./path/to/your/ca.pem');

const dispatcher = new Agent({
  connect: {
    ca: customCa,
    // key, cert, etc., can also be included in 'connect'
  }
});

const data = await ky('https://example.com', { dispatcher }).json();

Apparently undici is bundled with Node 18+, so no additional dependencies needed. This format is actually the same as what you would do to pass a CA cert to Node's fetch directly:

fetch('https://example.com', { dispatcher })
  .then(response => response.json());