docs: update readme to include bun install

[Electroid]

Updates the readme to add bun install instructions alongside npm and yarn.

[salesforce-cla]

Thanks for the contribution! Before we can merge this, we need @Electroid to sign the Salesforce Inc. Contributor License Agreement.

[Electroid]

Thanks for the contribution! Before we can merge this, we need @Electroid to sign the Salesforce Inc. Contributor License Agreement.

[colincasey]

Closing and reopening to trigger the salesforce-cla bot to refresh

[wjhsf]

@Electroid thanks for this suggestion! However, bun is not currently a runtime that we support, and we don't want to give a false impression by including it in the readme.

That being said, we are open to supporting bun, but we'd need a guarantee that the package works in that environment. We'd be happy accept a contribution that runs our unit tests in bun to provide that guarantee.

[Electroid]

@Electroid thanks for this suggestion! However, bun is not currently a runtime that we support, and we don't want to give a false impression by including it in the readme.

That being said, we are open to supporting bun, but we'd need a guarantee that the package works in that environment. We'd be happy accept a contribution that runs our unit tests in bun to provide that guarantee.

Hi @wjhsf, totally understand. I did try using Bun with your package and it does work!

Snippet using tough-cookie

// Example of using tough-cookie with Bun
import { Cookie, CookieJar } from 'tough-cookie';

async function main() {
  console.log('Testing tough-cookie with Bun...');
  
  // Create a cookie jar
  const cookieJar = new CookieJar();
  console.log('Cookie jar created');
  
  // Set some cookies
  await cookieJar.setCookie(
    'sessionId=abc123; Domain=example.com; Path=/; Secure; HttpOnly',
    'https://example.com/login'
  );
  
  await cookieJar.setCookie(
    'user=johndoe; Domain=example.com; Path=/; Expires=Tue, 21 Oct 2030 00:00:00 GMT',
    'https://example.com/profile'
  );
  
  await cookieJar.setCookie(
    '__Secure-theme=dark; Domain=example.com; Path=/; Secure',
    'https://example.com/settings'
  );
  
  // Get cookies for a specific URL
  const cookies = await cookieJar.getCookies('https://example.com/dashboard');
  console.log('Cookies for https://example.com/dashboard:');
  cookies.forEach(cookie => {
    console.log(`  - ${cookie.key}=${cookie.value}`);
  });
  
  // Parse a Set-Cookie header
  const setCookieHeader = 'preference=language=en; Domain=example.com; Path=/; Max-Age=31536000';
  const parsedCookie = Cookie.parse(setCookieHeader);
  console.log('\nParsed cookie from header:');
  console.log(`  Key: ${parsedCookie.key}`);
  console.log(`  Value: ${parsedCookie.value}`);
  console.log(`  Domain: ${parsedCookie.domain}`);
  console.log(`  Path: ${parsedCookie.path}`);
  console.log(`  Expires: ${parsedCookie.expires}`);
  
  // Generate a Set-Cookie header
  const newCookie = new Cookie({
    key: 'visited',
    value: 'true',
    domain: 'example.com',
    path: '/',
    secure: true,
    httpOnly: true,
    maxAge: 86400 // 1 day in seconds
  });
  
  console.log('\nGenerated Set-Cookie header:');
  console.log(newCookie.toString());
  
  // SameSite example
  await cookieJar.setCookie(
    'strict=authorized; SameSite=strict; Domain=example.com; Path=/',
    'https://example.com/'
  );
  
  await cookieJar.setCookie(
    'lax=okay; SameSite=lax; Domain=example.com; Path=/',
    'https://example.com/'
  );
  
  const laxCookies = await cookieJar.getCookies('https://example.com/', {
    sameSiteContext: 'lax'
  });
  
  console.log('\nCookies with sameSiteContext=lax:');
  laxCookies.forEach(cookie => {
    console.log(`  - ${cookie.key}=${cookie.value} (SameSite=${cookie.sameSite || 'none'})`);
  });
}

main().catch(err => console.error('Error:', err));

Output using Bun

❯ bun example.js
Testing tough-cookie with Bun...
Cookie jar created
Cookies for https://example.com/dashboard:
  - sessionId=abc123
  - user=johndoe
  - __Secure-theme=dark

Parsed cookie from header:
  Key: preference
  Value: language=en
  Domain: example.com
  Path: /
  Expires: Infinity

Generated Set-Cookie header:
visited=true; Max-Age=86400; Domain=example.com; Path=/; Secure; HttpOnly

Cookies with sameSiteContext=lax:
  - sessionId=abc123 (SameSite=none)
  - user=johndoe (SameSite=none)
  - __Secure-theme=dark (SameSite=none)
  - lax=okay (SameSite=lax)

Bun has a built-in test runner that's compatible with Jest, but we don't yet support jest.advanceTimersByTime(), so I'd love to submit another PR to run your tests in CI when we do support it.

I did run your test/scripts/vows.js in Bun, and it does work.

The last thing I was gonna mention was that you actually can use bun install with Node.js as your runtime. In fact, we have a lot of developers that start this way, especially if there's a runtime feature we haven't implemented in Bun yet.

[wjhsf]

Bun has a built-in test runner that's compatible with Jest, but we don't yet support jest.advanceTimersByTime(), so I'd love to submit another PR to run your tests in CI when we do support it.

I did run your test/scripts/vows.js in Bun, and it does work.

I'd imagine that it doesn't make much of a difference, but just as a footnote we'll be switching to vitest soon. I'm working on a PR for after we switch to ESM (#506, which also removes the CJS-only vows tests).