From 03ee0a2099a5d19eed640a7a8e310631cbc2b132 Mon Sep 17 00:00:00 2001 From: Marc Rousavy Date: Wed, 17 Jan 2024 11:58:32 +0100 Subject: [PATCH] feat: Expose `FrameProcessorPlugin` TS type --- package/src/FrameProcessorPlugins.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/package/src/FrameProcessorPlugins.ts b/package/src/FrameProcessorPlugins.ts index 80d6e16..aa9d5ee 100644 --- a/package/src/FrameProcessorPlugins.ts +++ b/package/src/FrameProcessorPlugins.ts @@ -10,7 +10,11 @@ import { assertJSIAvailable } from './JSIHelper' type BasicParameterType = string | number | boolean | undefined type ParameterType = BasicParameterType | BasicParameterType[] | Record -interface FrameProcessorPlugin { +/** + * An initialized native instance of a FrameProcessorPlugin. + * All memory allocated by this plugin will be deleted once this value goes out of scope. + */ +export interface FrameProcessorPlugin { /** * Call the native Frame Processor Plugin with the given Frame and options. * @param frame The Frame from the Frame Processor.