Модуль

Плагин Runium представляет собой JavaScript-модуль, экспортирующий по умолчанию функцию, которая возвращает объект типа Plugin.

Функция в качестве параметра может принимать объект с опциями плагина PluginOptions.

TIP

Runium поддерживает работу только с ESM. Работа с CommonJS-модулями не гарантируется.

TypeScript

Для разработки плагина рекомендуется использовать TypeScript.

Типы плагина определены в пакете @runium/types-plugin.

Пример

Без опций

import { Plugin } from "@runium/types-plugin"

export default function (): Plugin {
  return {
    name: "some-plugin",
    // остльные свойства
  } as Plugin
}

С опциями

import { Plugin } from "@runium/types-plugin"

interface PluginOptions {
  timeout: number
}

export default function (options: PluginOptions): Plugin {
  return {
    name: "some-plugin",
    // остальные свойства
  } as Plugin
}