NPM пакет¶

Описание¶

Начиная со сборки 2.0.160, Web SDK доступен в виде NPM пакета @flashphoner/websdk

npm i @flashphoner/websdk

Пакет содержит как исходные тексты для сборки, так и готовую сборку для использования в браузере

<script type="text/javascript" src="node_modules/@flashphoner/websdk/flashphoner.js"></script>

В подкаталоге examples пакета доступны демо-примеры

Поддержка фреймворков¶

В настоящее время, протестировано использование NPM пакета в приложениях на следующих фреймворкам

Поддержка Typescript¶

В сборке 2.0.203 добавлена типизация экспортируемых функций и классов для использования в приложениях на Typescript. Файлы объявлений Typescript располагаются в одном каталоге с исходными текстами

# ls -n @flashphoner/websdk/src/*.d.ts
-rw-r--r-- 1 1000 1000   33 Oct 12 14:16 @flashphoner/websdk/src/constants.d.ts
-rw-r--r-- 1 1000 1000 6768 Oct 12 14:30 @flashphoner/websdk/src/flashphoner-core.d.ts
-rw-r--r-- 1 1000 1000  768 Oct 12 14:44 @flashphoner/websdk/src/room-module.d.ts

Пример использования Web SDK в React приложении на Typescript описан здесь.

Использование RoomApi в React приложении¶

Для того, чтобы основные функции WebSDK работали корректно при использовании RoomApi в React приложении, необходим дополнительный импорт

import * as Flashphoner from '@flashphoner/websdk/src/flashphoner-core.js';
import * as RoomApi from '@flashphoner/websdk/src/room-module.js';