first type definitions for restrainer

This commit is contained in:
Elena Schramme 2024-04-04 10:35:45 -07:00
parent 64b4559786
commit cc73b724a1

View File

@ -1,9 +1,37 @@
import { Widget } from "src/types/modalities";
type RestrainerProps = {
// define expected input here and it's type (number, string, etc.)
visualComplexity: number;
audioComplexity: number;
widgets: {[key: string]: Widget};
// add more as needed
};
type ModalityMeasureRange = {
min: number;
max: number;
};
type ModalityMeasureBoundary = {
min: number;
max: number;
};
type ModalityMeasure = {
// for now it only takes into account how many visual and audio modalities are used
/**
* or use array instead of number and use objects with attributes such as volume, frequency
* amount of audios playing at the same time for example can be seen by the amout of objects in the list
*/
Visual: number;
Audio: number;
range: ModalityMeasureRange;
boundary: ModalityMeasureBoundary;
};
/**
* @description ???
* @param ???