{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Interface: EventsClientConfig"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/readme"},"children":["PERS SDK - v2.3.26"]}," / ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/modules"},"children":["Exports"]}," / EventsClientConfig"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"interface-eventsclientconfig","__idx":0},"children":["Interface: EventsClientConfig"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Events client configuration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"table-of-contents","__idx":1},"children":["Table of contents"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties","__idx":2},"children":["Properties"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/eventsclientconfig#wsurl"},"children":["wsUrl"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/eventsclientconfig#autoreconnect"},"children":["autoReconnect"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/eventsclientconfig#maxreconnectattempts"},"children":["maxReconnectAttempts"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/eventsclientconfig#reconnectdelay"},"children":["reconnectDelay"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/eventsclientconfig#connectiontimeout"},"children":["connectionTimeout"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/eventsclientconfig#debug"},"children":["debug"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/sdk-reference/interfaces/eventsclientconfig#tokenrefresher"},"children":["tokenRefresher"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"properties-1","__idx":3},"children":["Properties"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"wsurl","__idx":4},"children":["wsUrl"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["wsUrl"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["WS Relay server URL (wss://...)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in","__idx":5},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/events/types.ts#L70"},"children":["events/types.ts:70"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"autoreconnect","__idx":6},"children":["autoReconnect"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["autoReconnect"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reconnect on disconnect"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-1","__idx":7},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/events/types.ts#L72"},"children":["events/types.ts:72"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"maxreconnectattempts","__idx":8},"children":["maxReconnectAttempts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["maxReconnectAttempts"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Max reconnect attempts (default: 10)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-2","__idx":9},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/events/types.ts#L74"},"children":["events/types.ts:74"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reconnectdelay","__idx":10},"children":["reconnectDelay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["reconnectDelay"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reconnect delay in ms (default: 1000)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-3","__idx":11},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/events/types.ts#L76"},"children":["events/types.ts:76"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"connectiontimeout","__idx":12},"children":["connectionTimeout"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["connectionTimeout"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Connection timeout in ms (default: 30000)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-4","__idx":13},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/events/types.ts#L78"},"children":["events/types.ts:78"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"debug","__idx":14},"children":["debug"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["debug"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Debug logging"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-5","__idx":15},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/events/types.ts#L80"},"children":["events/types.ts:80"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tokenrefresher","__idx":16},"children":["tokenRefresher"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["• ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Optional"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["tokenRefresher"]},": () => ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]},"<",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},">"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Token refresh callback for reconnection (optional)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"type-declaration","__idx":17},"children":["Type declaration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["▸ (): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]},"<",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},">"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"returns","__idx":18},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Promise"]},"<",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},">"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"defined-in-6","__idx":19},"children":["Defined in"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/events/types.ts#L82"},"children":["events/types.ts:82"]}]}]},"headings":[{"value":"Interface: EventsClientConfig","id":"interface-eventsclientconfig","depth":1},{"value":"Table of contents","id":"table-of-contents","depth":2},{"value":"Properties","id":"properties","depth":3},{"value":"Properties","id":"properties-1","depth":2},{"value":"wsUrl","id":"wsurl","depth":3},{"value":"Defined in","id":"defined-in","depth":4},{"value":"autoReconnect","id":"autoreconnect","depth":3},{"value":"Defined in","id":"defined-in-1","depth":4},{"value":"maxReconnectAttempts","id":"maxreconnectattempts","depth":3},{"value":"Defined in","id":"defined-in-2","depth":4},{"value":"reconnectDelay","id":"reconnectdelay","depth":3},{"value":"Defined in","id":"defined-in-3","depth":4},{"value":"connectionTimeout","id":"connectiontimeout","depth":3},{"value":"Defined in","id":"defined-in-4","depth":4},{"value":"debug","id":"debug","depth":3},{"value":"Defined in","id":"defined-in-5","depth":4},{"value":"tokenRefresher","id":"tokenrefresher","depth":3},{"value":"Type declaration","id":"type-declaration","depth":4},{"value":"Returns","id":"returns","depth":5},{"value":"Defined in","id":"defined-in-6","depth":4}],"frontmatter":{"seo":{"title":"Interface: EventsClientConfig"}},"lastModified":"2026-08-21T18:40:55.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/sdk-reference/interfaces/eventsclientconfig","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}