Ana içeriğe geç

Müşteri Seçenekleri

IO fabrika seçenekleri​

forceNew​

Varsayılan değer: false

Yeni bir Manager örneği oluşturup oluşturmama.

Bir Manager örneği, sunucuya yapılan düşük seviyeli bağlantıdan sorumlu olup, yeniden bağlanma mantığını yönetir. Aşağıdaki örnek, birden fazla Socket örneği için aynı Manager örneğini yeniden kullanır:

const socket = io("https://example.com"); // ana isim alanı
const productSocket = io("https://example.com/product"); // "ürün" isim alanı
const orderSocket = io("https://example.com/order"); // "sipariş" isim alanı

Dikkat: Tek bir Manager, birden fazla Socket örneğine bağlanabilir.

multiplex​

Varsayılan değer: true

forceNew'un zıttı: var olan bir Manager örneğini yeniden kullanıp kullanmama.

const socket = io(); // 1. yöneticisi
const adminSocket = io("/admin", { multiplex: false }); // 2. yöneticisi

Düşük seviye motor seçenekleri​

bilgi

Bu ayarlar, aynı Manager'a bağlı tüm Socket örnekleri tarafından paylaşılacaktır.

addTrailingSlash​

V4.6.0'da eklendi

Varsayılan olarak eklenen son eğik çizgi artık devre dışı bırakılabilir:

import { io } from "socket.io-client";

const socket = io("https://example.com", {
  addTrailingSlash: false
});

autoUnref​

V4.0.0'da eklendi

Varsayılan değer: false

autoUnref true olarak ayarlandığında, Socket.IO istemcisi, etkin bir zamanlayıcı yoksa programın çıkmasına izin verir:

import { io } from "socket.io-client";

const socket = io({
  autoUnref: true
});

Yukarıdaki örnekte, istek URL'si https://example.com/socket.io olarak görülecektir.

closeOnBeforeunload​

Tarihçe

SürümDeğişiklikler
v4.7.1Seçenek artık varsayılan olarak false olacak.
v4.1.0İlk uygulama.

Varsayılan değer: false

Tarayıcıda beforeunload olayı yayımlandığında bağlantıyı kapatma:

not

Bu davranış Firefox için geçerlidir. Diğer tarayıcılarda bu olay tetiklenmeyecektir.

extraHeaders​

Ek başlıklar (sunucu tarafında socket.handshake.headers nesnesinde bulunur):

Müsteri

import { io } from "socket.io-client";

const socket = io({
  extraHeaders: {
    "my-custom-header": "1234"
  }
});
uyarı

Tarayıcı ortamında, sadece WebSocket taşınımı etkinse extraHeaders seçeneği yok sayılacaktır.

path​

Varsayılan değer: /socket.io/

Sunucu tarafında yakalanan yolun adıdır.

uyarı

Sunucu ve istemci değerleri eşleşmelidir.

import { io } from "socket.io-client";

const socket = io("https://example.com", {
  path: "/my-custom-path/"
});

transportOptions​

V2.0.0'da eklendi

Varsayılan değer: {}

Taşıma-özel seçenekler.

transports​

Varsayılan değer: ["polling", "websocket", "webtransport"]

Socket.IO sunucusuna düşük seviyeli bağlantı sağlar.

upgrade​

Varsayılan değer: true

İstemcinin taşımanın güncellenmesini denemesi gerekip gerekmediğini belirtir.

Yönetici seçenekleri​

bilgi

Bu ayarlar, aynı Manager'a bağlı tüm Socket örnekleri tarafından paylaşılacaktır.

autoConnect​

Varsayılan değer: true

Oluşturulduğunda otomatik olarak bağlanıp bağlanmayacağını belirler.

import { io } from "socket.io-client";

const socket = io({
  autoConnect: false
});

socket.connect();

parser​

V2.2.0'da eklendi

Varsayılan değer: require("socket.io-parser")

Paketleri işlemek için kullanılan ayrıştırıcı.