Functions Reference

Web SDK utility functions, initialization methods, and helper functions

Overview

This section provides a detailed reference for all functions available in the Suki Web SDK.

Initialize function

The initialize function is used to initialize the SDK with the provided options and returns a configured client instance.

The code snippet below shows how to use the initialize function to initialize the SDK with the provided options and returns a configured client instance.

JavaScript

import { initialize } from "@suki-sdk/js";

initialize(options: InitOptions): SDKClientInstance

Initializes the SDK with the provided options and returns a configured client instance.

Parameters

options · InitOptions · required

The configuration options required to initialize the SDK.

Returns

It returns a SDKClientInstance - The initialized SDK client instance is ready for use.

Next steps

Refer to Hooks for more information on the available hooks.