React Hooks

npm install @sukko/react

Functions

`SukkoProvider(__namedParameters: SukkoProviderProps): ReactNode`

`useConnectionState(): ConnectionStateResult`

`useSubscription(options: UseSubscriptionOptions<T>): UseSubscriptionResult<T>`

`useSukkoClient(): SukkoClient`

`useSukkoEvent(event: K, handler: unknown): void`

Types

`ConnectionState`

`Message`

`SukkoClientEvents`

`SukkoClientOptions`

`SukkoProviderProps`

`TypedMessage<T>`

`UseSubscriptionOptions<T>`

`UseSubscriptionResult<T>`

Constants

`SukkoContext`

Functions​

SukkoProvider(__namedParameters: SukkoProviderProps): ReactNode​

useConnectionState(): ConnectionStateResult​

useSubscription(options: UseSubscriptionOptions&lt;T&gt;): UseSubscriptionResult&lt;T&gt;​

useSukkoClient(): SukkoClient​

useSukkoEvent(event: K, handler: unknown): void​

Types​

ConnectionState​

Message​

SukkoClientEvents​

SukkoClientOptions​

SukkoProviderProps​

TypedMessage&lt;T&gt;​

UseSubscriptionOptions&lt;T&gt;​

UseSubscriptionResult&lt;T&gt;​

Constants​

SukkoContext​

Functions

`SukkoProvider(__namedParameters: SukkoProviderProps): ReactNode`

`useConnectionState(): ConnectionStateResult`

`useSubscription(options: UseSubscriptionOptions<T>): UseSubscriptionResult<T>`

`useSukkoClient(): SukkoClient`

`useSukkoEvent(event: K, handler: unknown): void`

Types

`ConnectionState`

`Message`

`SukkoClientEvents`

`SukkoClientOptions`

`SukkoProviderProps`

`TypedMessage<T>`

`UseSubscriptionOptions<T>`

`UseSubscriptionResult<T>`

Constants

`SukkoContext`