0.0.2 • Published 3 years ago

@studenfy/annex-pipe v0.0.2

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
3 years ago

Annex Pipe

Модуль, для коммуникации между аннексом и платформой Studenfy.

📦 Как установить?

yarn add @studenfy/annex-pipe

☝️ Важно

Чтобы ваше приложение смогло заработать на платформе Studenfy, вам необходимо отправить событие AnnexInit сразу после того, как оно будет готово к взаимодействию с пользователем.

Сделать это можно с помощью такого кода:

import annexPipe from '@studenfy/annex-pipe';

annexPipe.send('AnnexInit');

Как только платформа получает это событие, экран загрузки с лоадером пропадает и пользователь видит ваше приложение.

📚 Примеры использования

Простой запрос (запрос информации о студенте)

import annexPipe from '@studenfy/annex-pipe';

annexPipe.send('AnnexStudentGetInfo', { extended: true })
    .then(({ student }) => {
        console.log(student);
    })
    .catch((error) => {
        console.log(error);
    });

Подписка на события (подписка на изменение темы)

import annexPipe from '@studenfy/annex-pipe';

subscribe(({ result: { scheme } }) => {
    console.log(scheme);
}, 'AnnexChangeSchema');

Подписка на все события (вайлдкард)

import annexPipe from '@studenfy/annex-pipe';

subscribe(({ result }) => {
    console.log(result);
}, '*');
0.0.2

3 years ago

0.0.1

3 years ago