Skip to content

fix: SocketConnectOptions typo #486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: SocketConnectOptions typo #486

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { SocketConnectOption } from 'phoenix';
import type { SocketConnectOptions } from 'phoenix';

export type OnClientEvent = <Payload>(
collection: string,
Expand All @@ -11,7 +11,7 @@ export type OnClientEvent = <Payload>(
* @param token API key to use for API
* @param network `Network` type to use. Defaults to `Network.MAINNET`
* @param apiUrl Optional base URL to use for the API.
* @param connectOptions `SocketConnectOption` type to use to connect to the Stream API socket.
* @param connectOptions `SocketConnectOptions` type to use to connect to the Stream API socket.
* @param onError a callback function to use whenever errors occur in the SDK.
* @param logLevel `LogLevel` type to define the amount of logging the SDK should provide.
* @param onEvent a callback function to use whenever an event is emitted in the SDK. Can be used to globally apply some logic, e.g emitting metric/logging etc. If the onEvent handler returns false, event will be filtered and the subscription callback won't be invoked.
Expand All @@ -20,7 +20,7 @@ export type ClientConfig = {
network?: Network;
apiUrl?: string;
token: string;
connectOptions?: Partial<SocketConnectOption>;
connectOptions?: Partial<SocketConnectOptions>;
onError?: (error: unknown) => void;
logLevel?: LogLevel;
onEvent?: OnClientEvent;
Expand Down